home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / documents / irix5.2plusNewProds / usr_share_guidelines < prev   
Text File  |  1994-08-01  |  3KB  |  70 lines
  1.   ======================================================================
  2.   Guidelines for the use of the /usr/share filesystem
  3.   
  4.   Prepared by Mark Callow (msc@sgi.com)
  5.   
  6.   Introduction
  7.   ------------
  8.   
  9.   Shortly before IRIX 5.2 MR'ed, I discovered that it was impossible to
  10.   install the insight client software when your /usr/share is mounted
  11.   from another host.  The priority 1 bug I filed was made an exception
  12.   with the comments that a) the release notes should say that we do not
  13.   yet fully support /usr/share and b) we should publish some guidelines
  14.   about /usr/share for the benefit of our internal developers.
  15.   
  16.   Since I don't think anyone else is writing any guidelines and since I
  17.   have a bit of time right now, I decided to do it.  I'm forwarding this
  18.   to Tom Murphy for inclusion in whatever internal guide he feels is
  19.   appropriate.
  20.   
  21.   I welcome comments and additions to these guidelines.
  22.   
  23.   Purpose Of /usr/share
  24.   ---------------------
  25.   
  26.   /usr/share is intended as a repository for machine independent
  27.   executables and data files which can be shared between hosts by
  28.   cross mounting the entire directory.  The main goal in inventing it
  29.   was to reduce the amount of disk spaced required on the local host.
  30.   It meets this goal principally by making it easy to nfs mount this
  31.   huge amount of data.
  32.   
  33.   Prime candidates for inclusion in /usr/share are things like the
  34.   Insight books, the man pages, and the huge files of clip data for
  35.   applications such as Inventor, Explorer, Showcase and the digital media
  36.   tools.
  37.   
  38.   It is important to note that /usr/share will typically be mounted read-only.
  39.   
  40.   
  41.   Guidelines
  42.   ----------
  43.   
  44.   Given the purpose, three prime requirements become immediately
  45.   obvious.
  46.   
  47.   1.  A software product planning to install files in /usr/share must
  48.       put those files in a separate subsystem and at least the description
  49.       of that subsystem must say that it installs in /usr/share.
  50.   
  51.   2.  A product must never have hard prerequisites on something in
  52.       /usr/share because, on a machine with a mounted /usr/share, inst
  53.       will not be able to tell that the prerequisite software is present.
  54.   
  55.   3.  A product must never use /usr/share for any file intended to be
  56.       written to in the normal course of the product's operation.
  57.   
  58.   If these requirements are met, a product will be fully /usr/share
  59.   friendly.
  60.   
  61.   Number 3 raises the issue of where to put items that are to be available
  62.   for collaborative update.  Examples of these items are annotations for the
  63.   Insight books, adapted templates for speech recognition and
  64.   collaborative databases such as cdman's music catalog.  Since many sites
  65.   want to mount the entire /usr partition read-only these items should not
  66.   be put anywhere in /usr.  Such items should be placed in /var/public. 
  67.   Each product should have its own subdirectory (e.g. /var/public/Insight). 
  68.   
  69.   
  70.